数据查询API
生成查询密钥
在完成数据导入后,需要生成查询密钥,才可以通过API进行SQL查询,此时需要用到该命令生成项目的查询密钥,共有两种密钥,命令执行如下:
生成root查询密钥
ta-tool generate_root_secret
- 该密钥可查询所有表,支持跨项目跨表查询
生成单个项目的查询密钥
ta-tool generate_api_secret -appid TEST-APPID
- 传入的参数为对应的项目appid,该密钥只能查询该项目的数据(可对该项目的表进行跨表查询),不能查询其他项目的数据,也不能跨项目查询
调用查询API
在查询密钥生成后,您就可以通过调用查询API进行项目数据的查询,查询API的调用方式如下:
- 请使用POST方式提交调用请求
- url:
http://xxx:8992/querySql
(具体xxx基于部署的私有化环境不同) - 参数
- 参数1:token = 查询密钥,请填入您在上一步中获得的查询密钥
- 参数2:sql = 查询的SQL语句
- url:
返回结果
当TA后台收到查询请求后,会尝试进行查询并返回状态值,如果返回“0”则表示查询成功,一并返回查询结果,查询结果的格式如下:
{"data":{"headers":["#country","#province","#city"]},"return_code":0,"return_message":"success"}
["中国","甘肃省","兰州市"]
["中国","北京市","北京市"]
["中国","广东省","广州市"]
["中国","甘肃省","兰州市"]
- 参数headers包含了为查询结果的meta信息
- 之后是每行为一个列表,包含了返回的结果